<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Installing Golem &mdash; Golem v1.0 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    '',
          VERSION:     '1.0',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: ''
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/interface.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="contents" title="Global table of contents" href="contents.html" />
    <link rel="index" title="Global index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Golem v1.0 documentation" href="index.html" />
    <link rel="next" title="Summon" href="summon.html" />
    <link rel="prev" title="An overview of Golem" href="overview.html" />
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="summon.html" title="Summon"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="overview.html" title="An overview of Golem"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Golem v1.0 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  
  <div class="section" id="installing-golem">
<h1 id="installing-golem">Installing Golem<a class="headerlink" href="#installing-golem" title="Permalink to this headline">¶</a></h1>
<div class="section" id="prerequisites">
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
<p>Golem requires you to be using at least Python 2.4 (run <tt class="docutils literal"><span class="pre">python</span> <span class="pre">-V</span></tt> at the
shell to check what version you have installed), although we recommend Python
2.5. It was primarily developed on Mac OS X, but has been successfully run on
both Linux and Windows as well.</p>
<p>You can download Golem packages from <a class="reference external" href="http://code.google.com/p/pygolem/">http://code.google.com/p/pygolem/</a>.</p>
</div>
<div class="section" id="installation">
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>There are two ways to install Golem:</p>
<div class="section" id="using-easy-install-recommended">
<h3 id="using-easy-install-recommended">Using easy_install (recommended)<a class="headerlink" href="#using-easy-install-recommended" title="Permalink to this headline">¶</a></h3>
<p>To install using <tt class="docutils literal"><span class="pre">easy_install</span></tt>, you will first need to install it (if it
isn&#8217;t already installed). To do this, follow the instructions at
<a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">http://peak.telecommunity.com/DevCenter/EasyInstall</a>, or (if you&#8217;ve downloaded
a source distribution) run <tt class="docutils literal"><span class="pre">python</span> <span class="pre">ez_setup.py</span></tt>, which you can find in the
root of the unzipped Golem distribution.</p>
<p>At the shell, run <tt class="docutils literal"><span class="pre">easy_install</span> <span class="pre">golem</span></tt> to install Golem and all its
dependencies. If you&#8217;re running Windows, <tt class="docutils literal"><span class="pre">easy_install</span></tt> is found in the
<tt class="docutils literal"><span class="pre">Scripts</span></tt> subdirectory of your Python installation (typically something
like <tt class="docutils literal"><span class="pre">c:\Python25\Scripts\easy_install.exe</span></tt>).</p>
<p>Golem depends on the following libraries, which will be downloaded and
installed if you don&#8217;t already have them:</p>
<ul class="simple">
<li>lxml (<a class="reference external" href="http://www.codespeak.net/lxml/">http://www.codespeak.net/lxml/</a>), for XML parsing</li>
<li>simplejson (<a class="reference external" href="http://www.undefined.org/python/">http://www.undefined.org/python/</a>) for reading JSON</li>
</ul>
</div>
<div class="section" id="installing-golem-by-hand-on-unix-mac-os-x">
<h3 id="installing-golem-by-hand-on-unix-mac-os-x">Installing Golem by hand (on Unix / Mac OS X)<a class="headerlink" href="#installing-golem-by-hand-on-unix-mac-os-x" title="Permalink to this headline">¶</a></h3>
<p>Untar the Golem tarball you&#8217;ve downloaded (<tt class="docutils literal"><span class="pre">tar</span> <span class="pre">xvzf</span> <span class="pre">golem.tar.gz</span></tt>), and change into the directory that&#8217;s created.</p>
<p>Once again, you have two options. To install using <tt class="docutils literal"><span class="pre">setup.py</span></tt>, which is
recommended, run <tt class="docutils literal"><span class="pre">python</span> <span class="pre">./setup.py</span> <span class="pre">install</span></tt> (if necessary, as root) from
the root of the Golem distribution directory. This will, as above, download
the libraries Golem depends on and install them for you if you don&#8217;t have them
already.</p>
<p>Alternatively, if you&#8217;re just going to use the tools distributed with Golem,
particularly <tt class="docutils literal"><span class="pre">summon</span></tt>, run <tt class="docutils literal"><span class="pre">make</span> <span class="pre">&amp;&amp;</span> <span class="pre">sudo</span> <span class="pre">make</span> <span class="pre">install</span></tt> to install those
tools and the libraries they depend on. However, if you want to program using
the Golem library, or you&#8217;re a more experienced Python user, you should use
<tt class="docutils literal"><span class="pre">setup.py</span></tt>, as using the Makefile approach does <em>not</em> install the Golem
library into the standard location for user-installed Python libraries.</p>
</div>
<div class="section" id="installing-golem-by-hand-on-windows">
<h3 id="installing-golem-by-hand-on-windows">Installing Golem by hand on Windows<a class="headerlink" href="#installing-golem-by-hand-on-windows" title="Permalink to this headline">¶</a></h3>
<p>If you prefer to install from source, download <tt class="docutils literal"><span class="pre">golem.zip</span></tt> from
the download area and run  <tt class="docutils literal"><span class="pre">setup.py</span> <span class="pre">install</span></tt> as in the Unix instructions.</p>
<p>If you prefer to use a Windows installer, first install <tt class="docutils literal"><span class="pre">lxml</span></tt> and
<tt class="docutils literal"><span class="pre">simplejson</span></tt> (instructions can be found on their websites, above) and then
install <tt class="docutils literal"><span class="pre">golem-1.0.win32.exe</span></tt>, which can be obtained from the download area
at <a class="reference external" href="http://code.google.com/p/pygolem/">http://code.google.com/p/pygolem/</a> .</p>
</div>
<div class="section" id="more-information-for-windows-users">
<h3 id="more-information-for-windows-users">More information for Windows users<a class="headerlink" href="#more-information-for-windows-users" title="Permalink to this headline">¶</a></h3>
<p>Scripts such as <tt class="docutils literal"><span class="pre">summon</span></tt> will be installed into a subdirectory <tt class="docutils literal"><span class="pre">Scripts</span></tt>
of the directory where your Python install is, typically <tt class="docutils literal"><span class="pre">C:\Python25\</span></tt>. To
run Summon in that case, type <tt class="docutils literal"><span class="pre">C:\Python25\Python.exe</span>
<span class="pre">C:\Python25\Scripts\summon</span></tt>. Dictionaries are installed into
<tt class="docutils literal"><span class="pre">C:\Python25\site-packages\golem-[version]-py[version].egg\dictionaries\</span></tt>; e.g. <tt class="docutils literal"><span class="pre">C:\Python25\site-packages\golem-1.0-py2.5.egg\dictionaries\</span></tt>.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3>Table Of Contents</h3>
            <ul>
<li><a class="reference external" href="">Installing Golem</a><ul>
<li><a class="reference external" href="#prerequisites">Prerequisites</a></li>
<li><a class="reference external" href="#installation">Installation</a><ul>
<li><a class="reference external" href="#using-easy-install-recommended">Using easy_install (recommended)</a></li>
<li><a class="reference external" href="#installing-golem-by-hand-on-unix-mac-os-x">Installing Golem by hand (on Unix / Mac OS X)</a></li>
<li><a class="reference external" href="#installing-golem-by-hand-on-windows">Installing Golem by hand on Windows</a></li>
<li><a class="reference external" href="#more-information-for-windows-users">More information for Windows users</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="overview.html" title="previous chapter">An overview of Golem</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="summon.html" title="next chapter">Summon</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/install.txt">Show Source</a></li>
            </ul>
            <h3>Quick search</h3>
            <form class="search" action="search.html" method="get">
              <input type="text" name="q" size="18" /> <input type="submit" value="Go" />
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="summon.html" title="Summon"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="overview.html" title="An overview of Golem"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Golem v1.0 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2008, Andrew Walkingshaw.
      Last updated on Oct 01, 2008.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
    </div>
  </body>
</html>